/*
 * Copyright 2004 original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jbfilter.core.fcomps.multiple;

import java.util.Date;

import org.jbfilter.core.FilterComponent;
import org.jbfilter.core.NullTestingEnableable;
import org.jbfilter.core.PropertyAccessible;
import org.jbfilter.core.TruncateUnit;

/**
 * A component testing if a date property is between two dates (start date and end date).
 * To pass this filter component, a bean's property must comply as follows:
 * <ul>
 * <li>if both start/end dates are not null, the date (the property to test) must be between both (both borders included by default)</li>
 * <li>if start date is null, the date must be before the end date (border included by default)</li>
 * <li>if end date is null, the date must be after the start date (border included by default)</li>
 * <li>if null testing is on : if both start/end dates are null, the date must be null, too and at least one of the {@code isIncludeBorder} properties must be {@code true}</li>
 * </ul>
 * 
 * @author Marcus Adrian
 * @param <E> the beans' type
 */
public interface StartEndDateFilterComponent<E>
	extends
		FilterComponent<E>,
		NullTestingEnableable,
		PropertyAccessible {
	
	Date getStartDate();
	void setStartDate(Date startDate);
	Date getEndDate();
	void setEndDate(Date endDate);
	void setIncludeBorderStartDate(boolean includeBorder);
	void setIncludeBorderEndDate(boolean includeBorder);
	/**
	 * Sets the property for both the start date and end date.
	 * @see #setIncludeBorderStartDate(boolean)
	 * @see #setIncludeBorderEndDate(boolean)
	 */
	void setIncludeBorders(boolean includeBorder);
	/**
	 * Defaults to {@code true}.
	 * @return
	 */
	boolean isIncludeBorderStartDate();
	/**
	 * Defaults to {@code true}.
	 * @return
	 */
	boolean isIncludeBorderEndDate();
	/**
	 * Remind that a {@link Date} is very precise: up to the millisecond. So you might decide up
	 * to which precision you consider two dates as equivalent. This is done with this method.
	 * @param truncate the considered precision for the date comparison
	 */
	void setTruncate(TruncateUnit truncate);
	TruncateUnit getTruncate();
}
